<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AbstractEntityPropertiesService xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/core/AbstractEntityPropertiesService.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: AbstractEntityPropertiesService.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/core/AbstractEntityPropertiesService.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityProviderProperties.java - entity-broker - Jul 18, 2008 6:20:19 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.util.core;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.List;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Locale;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Map;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.MissingResourceException;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="31" href="#31">31</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityPropertiesService;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <em>/**<em>*</em></em>
<a name="34" href="#34">34</a>  <em> * This service allows us to track all the properties files related to describing the capabilities</em>
<a name="35" href="#35">35</a>  <em> * of our entities and the entities themselves, it allows lookup of strings as well&lt;br/></em>
<a name="36" href="#36">36</a>  <em> * NOTE: For internal use only, has no dependencies</em>
<a name="37" href="#37">37</a>  <em> * </em>
<a name="38" href="#38">38</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="39" href="#39">39</a>  <em> */</em>
<a name="40" href="#40">40</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/core/AbstractEntityPropertiesService.html">AbstractEntityPropertiesService</a> implements EntityPropertiesService {
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(AbstractEntityPropertiesService.<strong>class</strong>);
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <strong>public</strong> <strong>static</strong> <strong>interface</strong> MessageBundle {
<a name="45" href="#45">45</a>          <em>/**<em>*</em></em>
<a name="46" href="#46">46</a>  <em>         * Try to resolve the message. Treat as an error if the message can't be found.</em>
<a name="47" href="#47">47</a>  <em>         * @param key the code to lookup up, such as 'calculator.noRateSet'</em>
<a name="48" href="#48">48</a>  <em>         * @param args Array of arguments that will be filled in for params within</em>
<a name="49" href="#49">49</a>  <em>         * the message (params look like "{0}", "{1,date}", "{2,time}" within a message),</em>
<a name="50" href="#50">50</a>  <em>         * or &lt;code>null&lt;/code> if none.</em>
<a name="51" href="#51">51</a>  <em>         * @param locale the Locale in which to do the lookup</em>
<a name="52" href="#52">52</a>  <em>         * @return the resolved message</em>
<a name="53" href="#53">53</a>  <em>         * @throws IllegalArgumentException is the arguments are invalid</em>
<a name="54" href="#54">54</a>  <em>         * @throws MissingResourceException if the message wasn't found</em>
<a name="55" href="#55">55</a>  <em>         */</em>
<a name="56" href="#56">56</a>          <strong>public</strong> String getPropertyMessage(String key, Object[] args, Locale locale);
<a name="57" href="#57">57</a>          <em>/**<em>*</em></em>
<a name="58" href="#58">58</a>  <em>         * Get all the keys for a specific Locale</em>
<a name="59" href="#59">59</a>  <em>         * @param locale the Locale in which to do the lookup</em>
<a name="60" href="#60">60</a>  <em>         * @return the list of all keys found for the given Locale</em>
<a name="61" href="#61">61</a>  <em>         */</em>
<a name="62" href="#62">62</a>          <strong>public</strong> List&lt;String> getPropertyKeys(Locale locale);
<a name="63" href="#63">63</a>      }
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>      <strong>protected</strong> Map&lt;String, MessageBundle> prefixMap = <strong>new</strong> ConcurrentHashMap&lt;String, MessageBundle>();
<a name="66" href="#66">66</a>      <em>/**<em>*</em></em>
<a name="67" href="#67">67</a>  <em>     * Register this message bundle with the internal storage</em>
<a name="68" href="#68">68</a>  <em>     * @param prefix the related entity prefix for this message bundle</em>
<a name="69" href="#69">69</a>  <em>     * @param messageBundle the message bundle</em>
<a name="70" href="#70">70</a>  <em>     * @throws IllegalArgumentException is any arguments are null</em>
<a name="71" href="#71">71</a>  <em>     */</em>
<a name="72" href="#72">72</a>      <strong>public</strong> <strong>void</strong> registerPrefixMessageBundle(String prefix, MessageBundle messageBundle) {
<a name="73" href="#73">73</a>          <strong>if</strong> (prefix == <strong>null</strong> || messageBundle == <strong>null</strong>) {
<a name="74" href="#74">74</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"prefix and messageBundle cannot be null"</span>);
<a name="75" href="#75">75</a>          }
<a name="76" href="#76">76</a>          <strong>this</strong>.prefixMap.put(prefix, messageBundle);
<a name="77" href="#77">77</a>      }
<a name="78" href="#78">78</a>      <em>/**<em>*</em></em>
<a name="79" href="#79">79</a>  <em>     * Unregister this message bundle</em>
<a name="80" href="#80">80</a>  <em>     * @param prefix the related entity prefix for a message bundle</em>
<a name="81" href="#81">81</a>  <em>     * @throws IllegalArgumentException is any arguments are null</em>
<a name="82" href="#82">82</a>  <em>     */</em>
<a name="83" href="#83">83</a>      <strong>public</strong> <strong>void</strong> unregisterPrefixMessageBundle(String prefix) {
<a name="84" href="#84">84</a>          <strong>if</strong> (prefix == <strong>null</strong>) {
<a name="85" href="#85">85</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"prefix cannot be null"</span>);
<a name="86" href="#86">86</a>          }
<a name="87" href="#87">87</a>          <strong>this</strong>.prefixMap.remove(prefix);
<a name="88" href="#88">88</a>      }
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="91" href="#91">91</a>  <em class="comment">     * @see org.sakaiproject.entitybus.providers.EntityPropertiesService#getLocale()</em>
<a name="92" href="#92">92</a>  <em class="comment">     */</em>
<a name="93" href="#93">93</a>      <strong>public</strong> Locale getLocale() {
<a name="94" href="#94">94</a>          <strong>return</strong> Locale.getDefault();
<a name="95" href="#95">95</a>      }
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="98" href="#98">98</a>  <em class="comment">     * @see org.sakaiproject.entitybus.providers.EntityPropertiesService#loadProperties(java.lang.String, java.lang.String, java.lang.ClassLoader)</em>
<a name="99" href="#99">99</a>  <em class="comment">     */</em>
<a name="100" href="#100">100</a>     <strong>public</strong> <strong>void</strong> loadProperties(String prefix, String baseName, ClassLoader classLoader) {
<a name="101" href="#101">101</a>         <strong>if</strong> (prefix == <strong>null</strong>) {
<a name="102" href="#102">102</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot register properties for a null prefix"</span>);
<a name="103" href="#103">103</a>         }
<a name="104" href="#104">104</a>         Locale locale = getLocale();
<a name="105" href="#105">105</a>         <strong>if</strong> (classLoader == <strong>null</strong>) {
<a name="106" href="#106">106</a>             classLoader = Thread.currentThread().getContextClassLoader();
<a name="107" href="#107">107</a>         }
<a name="108" href="#108">108</a>         <strong>if</strong> (baseName == <strong>null</strong>) {
<a name="109" href="#109">109</a>             baseName = prefix;
<a name="110" href="#110">110</a>         }
<a name="111" href="#111">111</a>         List&lt;String> keys = registerLocaleMessages(prefix, baseName, locale, classLoader);
<a name="112" href="#112">112</a>         <strong>if</strong> (keys.size() > 0) {
<a name="113" href="#113">113</a>             log.info(<span class="string">"Added "</span>+keys.size()+<span class="string">" properties for entity prefix ("</span> + prefix + <span class="string">") and basename ("</span>+baseName+<span class="string">")"</span>);
<a name="114" href="#114">114</a>         } <strong>else</strong> {
<a name="115" href="#115">115</a>             log.warn(<span class="string">"No properties to load for entity prefix ("</span> + prefix + <span class="string">") and basename ("</span>+baseName+<span class="string">")"</span>);
<a name="116" href="#116">116</a>         }
<a name="117" href="#117">117</a>     }
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em>/**<em>*</em></em>
<a name="120" href="#120">120</a> <em>     * Override this to provide custom message handling,</em>
<a name="121" href="#121">121</a> <em>     * you must register the {@link MessageBundle} you create in this method so that the</em>
<a name="122" href="#122">122</a> <em>     * messages can be looked up later, register using {@link #registerPrefixMessageBundle(String, MessageBundle)}</em>
<a name="123" href="#123">123</a> <em>     * </em>
<a name="124" href="#124">124</a> <em>     * @param prefix an entity prefix</em>
<a name="125" href="#125">125</a> <em>     * @param baseName (optional) the part before the .properties or _en.properties,</em>
<a name="126" href="#126">126</a> <em>     * example: location/dir/myentity.properties, if null then prefix is used</em>
<a name="127" href="#127">127</a> <em>     * @param locale the Locale to register messages for</em>
<a name="128" href="#128">128</a> <em>     * @param classLoader (optional) the ClassLoader to find the properties files in,</em>
<a name="129" href="#129">129</a> <em>     * if null then the default thread ClassLoader is used</em>
<a name="130" href="#130">130</a> <em>     * @return the list of registered keys for this Locale</em>
<a name="131" href="#131">131</a> <em>     */</em>
<a name="132" href="#132">132</a>     <strong>public</strong> <strong>abstract</strong> List&lt;String> registerLocaleMessages(String prefix, String baseName, Locale locale, ClassLoader classLoader);
<a name="133" href="#133">133</a> 
<a name="134" href="#134">134</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="135" href="#135">135</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.entityprovider.EntityPropertiesServiceAPI#unloadProperties(java.lang.String)</em>
<a name="136" href="#136">136</a> <em class="comment">     */</em>
<a name="137" href="#137">137</a>     <strong>public</strong> <strong>boolean</strong> unloadProperties(String prefix) {
<a name="138" href="#138">138</a>         <strong>boolean</strong> unreg = false;
<a name="139" href="#139">139</a>         <strong>if</strong> (prefix != <strong>null</strong>) {
<a name="140" href="#140">140</a>             unreg = (prefixMap.remove(prefix) != <strong>null</strong>);
<a name="141" href="#141">141</a>         }
<a name="142" href="#142">142</a>         <strong>return</strong> unreg;
<a name="143" href="#143">143</a>     }
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="146" href="#146">146</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.entityprovider.EntityPropertiesServiceAPI#getProperty(java.lang.String, java.lang.String)</em>
<a name="147" href="#147">147</a> <em class="comment">     */</em>
<a name="148" href="#148">148</a>     <strong>public</strong> String getProperty(String prefix, String key) {
<a name="149" href="#149">149</a>         <strong>return</strong> getProperty(prefix, key, <strong>null</strong>);
<a name="150" href="#150">150</a>     }
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="153" href="#153">153</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.entityprovider.EntityPropertiesServiceAPI#getProperty(java.lang.String, java.lang.String, java.util.Locale)</em>
<a name="154" href="#154">154</a> <em class="comment">     */</em>
<a name="155" href="#155">155</a>     <strong>public</strong> String getProperty(String prefix, String key, Locale locale) {
<a name="156" href="#156">156</a>         <strong>return</strong> getProperty(prefix, key, locale, <strong>null</strong>);
<a name="157" href="#157">157</a>     }
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="160" href="#160">160</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.entityprovider.EntityPropertiesServiceAPI#getProperty(java.lang.String, java.lang.String, java.util.Locale, java.lang.String)</em>
<a name="161" href="#161">161</a> <em class="comment">     */</em>
<a name="162" href="#162">162</a>     <strong>public</strong> String getProperty(String prefix, String key, Locale locale, String defaultValue) {
<a name="163" href="#163">163</a>         <strong>if</strong> (prefix == <strong>null</strong>) {
<a name="164" href="#164">164</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot get properties for a null prefix"</span>);
<a name="165" href="#165">165</a>         }
<a name="166" href="#166">166</a>         <strong>if</strong> (key == <strong>null</strong>) {
<a name="167" href="#167">167</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot get properties for a null key"</span>);
<a name="168" href="#168">168</a>         }
<a name="169" href="#169">169</a>         <strong>if</strong> (locale == <strong>null</strong>) {
<a name="170" href="#170">170</a>             locale = getLocale();
<a name="171" href="#171">171</a>         }
<a name="172" href="#172">172</a>         String value = <strong>null</strong>;
<a name="173" href="#173">173</a>         MessageBundle messageBundle = prefixMap.get(prefix);
<a name="174" href="#174">174</a>         <strong>if</strong> (messageBundle != <strong>null</strong>) {
<a name="175" href="#175">175</a>             <strong>try</strong> {
<a name="176" href="#176">176</a>                 value = (String) messageBundle.getPropertyMessage(key, <strong>null</strong>, locale);
<a name="177" href="#177">177</a>             } <strong>catch</strong> (MissingResourceException e) {
<a name="178" href="#178">178</a>                 value = <strong>null</strong>;
<a name="179" href="#179">179</a>             }
<a name="180" href="#180">180</a>         }
<a name="181" href="#181">181</a>         <strong>if</strong> (value == <strong>null</strong>) {
<a name="182" href="#182">182</a>             value = defaultValue;
<a name="183" href="#183">183</a>         }
<a name="184" href="#184">184</a>         <strong>return</strong> value;
<a name="185" href="#185">185</a>     }
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

